<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.7"/>
<title>BrainTrain: brtr::WeaponHUD Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">BrainTrain
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.7 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classbrtr_1_1_weapon_h_u_d.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classbrtr_1_1_weapon_h_u_d-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">brtr::WeaponHUD Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><a class="el" href="classbrtr_1_1_weapon_h_u_d.html" title="WeaponHUD class, provides the functions to add a HUD camera to the scene. ">WeaponHUD</a> class, provides the functions to add a HUD camera to the scene.  
 <a href="classbrtr_1_1_weapon_h_u_d.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_weapon_h_u_d_8h_source.html">WeaponHUD.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for brtr::WeaponHUD:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classbrtr_1_1_weapon_h_u_d.png" usemap="#brtr::WeaponHUD_map" alt=""/>
  <map id="brtr::WeaponHUD_map" name="brtr::WeaponHUD_map">
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbrtr_1_1_weapon_h_u_d_1_1_weapon_switch_handler.html">WeaponSwitchHandler</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">EventHandler for WeaponSwitching.  <a href="classbrtr_1_1_weapon_h_u_d_1_1_weapon_switch_handler.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a8bc53d9bc7df80c28e2d9eeeed113281"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbrtr_1_1_weapon_h_u_d.html#a8bc53d9bc7df80c28e2d9eeeed113281">WeaponHUD</a> ()</td></tr>
<tr class="separator:a8bc53d9bc7df80c28e2d9eeeed113281"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a79723105b944c088928741a620551d8d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbrtr_1_1_weapon_h_u_d.html#a79723105b944c088928741a620551d8d">WeaponHUD</a> (const <a class="el" href="classbrtr_1_1_weapon_h_u_d.html">WeaponHUD</a> &amp;, const CopyOp &amp;copyop=CopyOp::SHALLOW_COPY)</td></tr>
<tr class="separator:a79723105b944c088928741a620551d8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6a9a434ff3aa3861caf030763772ac74"><td class="memItemLeft" align="right" valign="top">ref_ptr&lt; <a class="el" href="classbrtr_1_1_weapon_h_u_d_1_1_weapon_switch_handler.html">WeaponSwitchHandler</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbrtr_1_1_weapon_h_u_d.html#a6a9a434ff3aa3861caf030763772ac74">getWeaponHandler</a> ()</td></tr>
<tr class="separator:a6a9a434ff3aa3861caf030763772ac74"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab8ccf2821f698af567b7ce40eb6840d8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbrtr_1_1_weapon_h_u_d.html#ab8ccf2821f698af567b7ce40eb6840d8">addPortalGun</a> ()</td></tr>
<tr class="memdesc:ab8ccf2821f698af567b7ce40eb6840d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">a portal gun is added to the weapon switch  <a href="#ab8ccf2821f698af567b7ce40eb6840d8">More...</a><br /></td></tr>
<tr class="separator:ab8ccf2821f698af567b7ce40eb6840d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaaa6c5e92034b7efb6194032f6ffca0f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbrtr_1_1_weapon_h_u_d.html#aaaa6c5e92034b7efb6194032f6ffca0f">~WeaponHUD</a> ()</td></tr>
<tr class="separator:aaaa6c5e92034b7efb6194032f6ffca0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:a86191d6e9041afc84575e77576464da9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbrtr_1_1_weapon_h_u_d.html#a86191d6e9041afc84575e77576464da9">createWeaponHUD</a> ()</td></tr>
<tr class="memdesc:a86191d6e9041afc84575e77576464da9"><td class="mdescLeft">&#160;</td><td class="mdescRight">creates a weapon hud with the default weapon crowbar  <a href="#a86191d6e9041afc84575e77576464da9">More...</a><br /></td></tr>
<tr class="separator:a86191d6e9041afc84575e77576464da9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a32d5e498c15faa87f3bcfa83ca6c5b0e"><td class="memItemLeft" align="right" valign="top">ref_ptr&lt; Switch &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbrtr_1_1_weapon_h_u_d.html#a32d5e498c15faa87f3bcfa83ca6c5b0e">_switcher</a></td></tr>
<tr class="separator:a32d5e498c15faa87f3bcfa83ca6c5b0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4ebf9d9e600e3a6b9f5d8601c084ee51"><td class="memItemLeft" align="right" valign="top">ref_ptr&lt; <a class="el" href="classbrtr_1_1_weapon_h_u_d_1_1_weapon_switch_handler.html">WeaponSwitchHandler</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbrtr_1_1_weapon_h_u_d.html#a4ebf9d9e600e3a6b9f5d8601c084ee51">_handler</a></td></tr>
<tr class="separator:a4ebf9d9e600e3a6b9f5d8601c084ee51"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classbrtr_1_1_weapon_h_u_d.html" title="WeaponHUD class, provides the functions to add a HUD camera to the scene. ">WeaponHUD</a> class, provides the functions to add a HUD camera to the scene. </p>
<p>Use the mouse wheel to shift between weapons after picking up a second one </p><dl class="section author"><dt>Author</dt><dd>Jonathan Spielvogel </dd></dl>
<dl class="section version"><dt>Version</dt><dd>1.0 </dd></dl>
<dl class="section date"><dt>Date</dt><dd>2014 </dd></dl>
<dl class="section pre"><dt>Precondition</dt><dd>create a root node and attach the scene to it, then add the HUD to root </dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>GNU Public License. </dd></dl>

<p>Definition at line <a class="el" href="_weapon_h_u_d_8h_source.html#l00023">23</a> of file <a class="el" href="_weapon_h_u_d_8h_source.html">WeaponHUD.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a8bc53d9bc7df80c28e2d9eeeed113281"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">brtr::WeaponHUD::WeaponHUD </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Definition at line <a class="el" href="_weapon_h_u_d_8cpp_source.html#l00018">18</a> of file <a class="el" href="_weapon_h_u_d_8cpp_source.html">WeaponHUD.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a79723105b944c088928741a620551d8d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">brtr::WeaponHUD::WeaponHUD </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classbrtr_1_1_weapon_h_u_d.html">WeaponHUD</a> &amp;&#160;</td>
          <td class="paramname"><em>copy</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const CopyOp &amp;&#160;</td>
          <td class="paramname"><em>copyop</em> = <code>CopyOp::SHALLOW_COPY</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Definition at line <a class="el" href="_weapon_h_u_d_8cpp_source.html#l00011">11</a> of file <a class="el" href="_weapon_h_u_d_8cpp_source.html">WeaponHUD.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="aaaa6c5e92034b7efb6194032f6ffca0f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">brtr::WeaponHUD::~WeaponHUD </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Definition at line <a class="el" href="_weapon_h_u_d_8cpp_source.html#l00065">65</a> of file <a class="el" href="_weapon_h_u_d_8cpp_source.html">WeaponHUD.cpp</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ab8ccf2821f698af567b7ce40eb6840d8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void brtr::WeaponHUD::addPortalGun </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>a portal gun is added to the weapon switch </p>

<p>Definition at line <a class="el" href="_weapon_h_u_d_8cpp_source.html#l00073">73</a> of file <a class="el" href="_weapon_h_u_d_8cpp_source.html">WeaponHUD.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a86191d6e9041afc84575e77576464da9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void brtr::WeaponHUD::createWeaponHUD </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>creates a weapon hud with the default weapon crowbar </p>

<p>Definition at line <a class="el" href="_weapon_h_u_d_8cpp_source.html#l00022">22</a> of file <a class="el" href="_weapon_h_u_d_8cpp_source.html">WeaponHUD.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a6a9a434ff3aa3861caf030763772ac74"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ref_ptr&lt; <a class="el" href="classbrtr_1_1_weapon_h_u_d_1_1_weapon_switch_handler.html">WeaponHUD::WeaponSwitchHandler</a> &gt; brtr::WeaponHUD::getWeaponHandler </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Definition at line <a class="el" href="_weapon_h_u_d_8cpp_source.html#l00069">69</a> of file <a class="el" href="_weapon_h_u_d_8cpp_source.html">WeaponHUD.cpp</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a4ebf9d9e600e3a6b9f5d8601c084ee51"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">ref_ptr&lt;<a class="el" href="classbrtr_1_1_weapon_h_u_d_1_1_weapon_switch_handler.html">WeaponSwitchHandler</a>&gt; brtr::WeaponHUD::_handler</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Definition at line <a class="el" href="_weapon_h_u_d_8h_source.html#l00073">73</a> of file <a class="el" href="_weapon_h_u_d_8h_source.html">WeaponHUD.h</a>.</p>

</div>
</div>
<a class="anchor" id="a32d5e498c15faa87f3bcfa83ca6c5b0e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">ref_ptr&lt;Switch&gt; brtr::WeaponHUD::_switcher</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Definition at line <a class="el" href="_weapon_h_u_d_8h_source.html#l00072">72</a> of file <a class="el" href="_weapon_h_u_d_8h_source.html">WeaponHUD.h</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>header/<a class="el" href="_weapon_h_u_d_8h_source.html">WeaponHUD.h</a></li>
<li>Camera/<a class="el" href="_weapon_h_u_d_8cpp_source.html">WeaponHUD.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="namespacebrtr.html">brtr</a></li><li class="navelem"><a class="el" href="classbrtr_1_1_weapon_h_u_d.html">WeaponHUD</a></li>
    <li class="footer">Generated on Thu Jul 17 2014 01:40:33 for BrainTrain by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.7 </li>
  </ul>
</div>
</body>
</html>
